/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

package com.imesne.office.excel.html;

import org.apache.poi.ss.usermodel.CellStyle;
import org.apache.poi.ss.usermodel.Workbook;

import java.util.List;

/**
 * This interface is used where code wants to be independent of the workbook
 * formats.  If you are writing such code, you can add a method to this
 * interface, and then implement it for both HSSF and XSSF workbooks, letting
 * the driving code stay independent of format.
 *
 * @author Ken Arnold, Industrious Media LLC
 */
public interface HtmlHelper {

    /**
     * 获取cell的html样式
     *
     * @param workbook the workbook
     * @param style    the style
     * @return list
     */
    List<String> cellStyleToHtmlStyle(Workbook workbook, CellStyle style);

    /**
     * 获取cellStyle的全局css样式名
     * (当单元格没有指定样式时，使用全局的样式，此时css样式名应该相同)
     *
     * @param workbook the workbook
     * @param style    the style
     * @return string
     */
    String cellStyleName(Workbook workbook, CellStyle style);

    /**
     * 样式名称是否已存在
     * 必须调用此方法判断一致性，某此情况下CellStyle.equals()相同，style.getIndex()不同
     *
     * @param style the style
     * @return boolean
     */
    boolean isCellStyleNameExists(CellStyle style);
}
